Start special-features section in readme #29

diff --git a/README.org b/README.org
index e523a33327d25b7c637a12f12a3d5a7614778d42..b472cb540fbe3caaa3f410a3e5b5aadc8e825bc9 100644 (file)
--- a/README.org
+++ b/README.org
@@ -1,5 +1,21 @@
+* which-key
 Rewrite of guide-key-mode for emacs. 
 
+* Table of Contents                                                   :TOC@4:
+ - [[#which-key][which-key]]
+ - [[#install][Install]]
+     - [[#minibuffer-option][Minibuffer Option]]
+     - [[#side-window-right-option][Side Window Right Option]]
+     - [[#side-window-bottom-option][Side Window Bottom Option]]
+ - [[#statusgoals][Status/Goals]]
+     - [[#stability][Stability]]
+     - [[#completed-goals][Completed Goals]]
+     - [[#incomplete-and-planned][Incomplete and Planned]]
+ - [[#special-features][Special Features]]
+     - [[#several-popup-types][Several Popup Types]]
+     - [[#custom-string-replacement][Custom String Replacement]]
+     - [[#nice-display-with-split-frame][Nice Display with Split Frame]]
+
 * Install
 Add which-key.el to your =load-path= and require. Something like 
 
@@ -49,7 +65,6 @@ Popup side window on right. For defaults use
 
 [[./img/which-key-right.png]]
 
-
 ** Side Window Bottom Option
 Popup side window on bottom. For defaults use
 
@@ -59,7 +74,6 @@ Popup side window on bottom. For defaults use
 
 [[./img/which-key-bottom.png]]
 
-
 * Status/Goals
 ** Stability
 - It's very much a work in progress, so expect weird things to happen from time
@@ -71,11 +85,24 @@ Popup side window on bottom. For defaults use
    where possible.
 3. Add support for replacement lists to modify key descriptions on the fly.
    Currently you can replace in the key or description field using regexp, and
-   using a key sequence (like ="C-x 1"=) to fully replace the description (the
+   using a key sequence (like =C-x 1=) to fully replace the description (the
    latter can target major modes, too).
 ** Incomplete and Planned
 1. Come up with creative ways to fit more keys in buffer while still maintaining
    nice alignment and formatting. Such as
    1. Automatic text scaling
-   2. Paging functionality 
-
+   2. Paging functionality
+
+* Special Features
+** Several Popup Types
+TODO...
+** Custom String Replacement
+TODO...
+** Nice Display with Split Frame
+Unlike guide-key, which-key looks good even if the frame is split into several
+windows.
+#+CAPTION: which-key in a frame with 3 horizontal splits
+[[./img/which-key-right-split.png]]
+
+#+CAPTION: which-key in a frame with 2 vertical splits
+[[./img/which-key-bottom-split.png]]

diff --git a/img/which-key-bottom-split.png b/img/which-key-bottom-split.png
new file mode 100644 (file)
index 0000000..b1d1de9
Binary files /dev/null and b/img/which-key-bottom-split.png differ

diff --git a/img/which-key-right-split.png b/img/which-key-right-split.png
new file mode 100644 (file)
index 0000000..944293f
Binary files /dev/null and b/img/which-key-right-split.png differ